/*
 * mana (library)
 * Copyright (c) 2003 Shun Moriya <shun@mnu.sakura.ne.jp>
 *
 * The MIT License
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
 * THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

/*!
 * @file
 * @brief	mana_datalinkクラスに関するヘッダーファイル
 *
 * このファイルはmana_datalinkクラスに関係するヘッダーファイルです。
 * manaコンパイラはスクリプトでalias指定され、かつ参照されているリソースを
 * 結合します。
 * mana_datalinkクラスは結合されたデータを参照する機能を持っています。
 *
 * @author	Shun Moriya <shun@mnu.sakura.ne.jp>
 */

#if !defined(___MANA_DATALINK_H___)
#define ___MANA_DATALINK_H___

#if defined(_LANGUAGE_C_PLUS_PLUS) || defined(__cplusplus) || defined(c_plusplus)
extern "C" {
#endif

#define MANA_DATALINK_STANDARD_ALIGNMENT_SIZE	(sizeof(void*))

/*! @brief datalinkファイルのヘッダー */
typedef struct mana_datalink_file_header
{
	unsigned int total_data_size;	/*!< @brief 全体サイズ */
	int number_of_datas;			/*!< @brief データの個数 */
} mana_datalink_file_header;

/*! @brief datalinkファイル内のデータの情報 */
typedef struct mana_datalink_info_header
{
	unsigned int offset;			/*!< @brief 先頭からのオフセット */
	unsigned int size;				/*!< @brief データのサイズ */
} mana_datalink_info_header;

/*! @brief mana_datalink */
/*!
 * @brief	mana_datalinkクラス
 * mana_datalinkクラスは結合されたデータを参照します。
 * C++でいうところのメンバー変数ですが、C言語なので全てpublicになっています。
 * 操作用の関数を用意しているので、それらの関数を利用して操作してください。
 */
typedef struct mana_datalink
{
	/*! @brief datalinkファイルのヘッダー */
	mana_datalink_info_header* datalink_info_header_pointer;
	unsigned char* data_pointer;	/*!< @brief データセクション先頭アドレス */
	int number_of_entries;			/*!< @brief データの個数 */
} mana_datalink;

/*! @brief mana_datalink オブジェクトの生成 */
extern mana_datalink* mana_datalink_create(void);

/*! @brief mana_datalink オブジェクトの破棄 */
extern void mana_datalink_destroy(mana_datalink* self);

/*! @brief mana_datalink オブジェクトの初期化 */
extern void mana_datalink_initialize(mana_datalink* self);

/*! @brief mana_datalink オブジェクトの終了化 */
extern void mana_datalink_finalize(mana_datalink* self);

/*! @brief datalinkファイルの読み込み */
extern void mana_datalink_load(mana_datalink* self, const void* buffer);

/*! @brief datalinkファイルの開放 */
extern void mana_datalink_release(mana_datalink* self);

/*! @brief datalinkファイル内のデータ数を取得 */
extern int mana_datalink_get_number_of_datas(const mana_datalink* self);

/*! @brief データのサイズを取得 */
extern int mana_datalink_get_data_size(const mana_datalink* self, const int index);

/*! @brief データのアドレスを取得 */
extern const void* mana_datalink_get_data(const mana_datalink* self, const int index);

#if defined(_LANGUAGE_C_PLUS_PLUS) || defined(__cplusplus) || defined(c_plusplus)
}
#endif

#endif
